Create an allocation

POST

allocations

curl --request POST \
  --url https://your_a2_service/allocations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ext": {},
  "last_comment": "",
  "updated_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://your_a2_service/allocations"

payload = {
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ext": {},
    "last_comment": "",
    "updated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    owner_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tagid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    cid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    created_at: '2023-11-07T05:31:56Z',
    crid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    ext: {},
    last_comment: '',
    updated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://your_a2_service/allocations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your_a2_service/allocations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'owner_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tagid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'cid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'created_at' => '2023-11-07T05:31:56Z',
    'crid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'ext' => [
        
    ],
    'last_comment' => '',
    'updated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your_a2_service/allocations"

	payload := strings.NewReader("{\n  \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"cid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"crid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ext\": {},\n  \"last_comment\": \"\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your_a2_service/allocations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"cid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"crid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ext\": {},\n  \"last_comment\": \"\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/allocations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"cid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"crid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ext\": {},\n  \"last_comment\": \"\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "no": 123,
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ext": {},
  "last_comment": "",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Schema for creating allocation entity.

owner_id

string<uuid>

required

The id of the user who created this allocation

status

enum<string>

required

Represents the status of an allocation between a campaign and placement.

Available options:

pending,

requested,

published,

rejected,

canceled,

finished

tagid

string<uuid>

required

The id of the placement where the campaign will be allocated

cid

string<uuid> | null

The id of the campaign to be allocated to the placement

created_at

string<date-time> | null

The date and time the entity was created.

crid

string<uuid> | null

deprecated

ext

Ext · object

last_comment

string

default:""

Most recent comment added by retailer during the allocation approval process

updated_at

string<date-time> | null

The date and time the entity was last updated.

Response

Successful Response

Schema for reading allocation entity.

integer

required

The number of the allocation

owner_id

string<uuid>

required

The id of the user who created this allocation

status

string

required

The current status of the allocation (e.g. draft, published, rejected)

tagid

string<uuid>

required

The id of the placement where the campaign will be allocated

cid

string<uuid> | null

The id of the campaign to be allocated to the placement

created_at

string<date-time> | null

The date and time the entity was created.

crid

string<uuid> | null

deprecated

ext

Ext · object

last_comment

string

default:""

Most recent comment added by retailer during the allocation approval process

updated_at

string<date-time> | null

The date and time the entity was last updated.

Create an allocation

curl --request POST \
  --url https://your_a2_service/allocations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ext": {},
  "last_comment": "",
  "updated_at": "2023-11-07T05:31:56Z"
}
'

import requests

url = "https://your_a2_service/allocations"

payload = {
    "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "ext": {},
    "last_comment": "",
    "updated_at": "2023-11-07T05:31:56Z"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    owner_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    tagid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    cid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    created_at: '2023-11-07T05:31:56Z',
    crid: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    ext: {},
    last_comment: '',
    updated_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://your_a2_service/allocations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://your_a2_service/allocations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'owner_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'tagid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'cid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'created_at' => '2023-11-07T05:31:56Z',
    'crid' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'ext' => [
        
    ],
    'last_comment' => '',
    'updated_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://your_a2_service/allocations"

	payload := strings.NewReader("{\n  \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"cid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"crid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ext\": {},\n  \"last_comment\": \"\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://your_a2_service/allocations")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"cid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"crid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ext\": {},\n  \"last_comment\": \"\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://your_a2_service/allocations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"owner_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"tagid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"cid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"created_at\": \"2023-11-07T05:31:56Z\",\n  \"crid\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"ext\": {},\n  \"last_comment\": \"\",\n  \"updated_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body

{
  "no": 123,
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "tagid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "crid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ext": {},
  "last_comment": "",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Data Management APIs

Decision APIs

Authorizations

Body

Response